

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" />
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  
  <title>API 文档 &mdash; Ceph Documentation</title>
  

  
  <link rel="stylesheet" href="../_static/ceph.css" type="text/css" />
  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
  <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />

  
  
    <link rel="shortcut icon" href="../_static/favicon.ico"/>
  

  
  

  

  
  <!--[if lt IE 9]>
    <script src="../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
        <script src="../_static/jquery.js"></script>
        <script src="../_static/underscore.js"></script>
        <script src="../_static/doctools.js"></script>
    
    <script type="text/javascript" src="../_static/js/theme.js"></script>

    
    <link rel="index" title="Index" href="../genindex/" />
    <link rel="search" title="Search" href="../search/" />
    <link rel="next" title="cephadm" href="mon_command_api/" />
    <link rel="prev" title="CLI API Commands Module" href="../mgr/cli_api/" /> 
</head>

<body class="wy-body-for-nav">

   
  <header class="top-bar">
    

















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../" class="icon icon-home"></a> &raquo;</li>
        
      <li>API 文档</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="../_sources/api/index.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
  </header>
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search"  style="background: #eee" >
          

          
            <a href="../">
          

          
            
            <img src="../_static/logo.png" class="logo" alt="Logo"/>
          
          </a>

          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search/" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        
        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../start/intro/">Ceph 简介</a></li>
<li class="toctree-l1"><a class="reference internal" href="../install/">安装 Ceph</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cephadm/">Cephadm</a></li>
<li class="toctree-l1"><a class="reference internal" href="../rados/">Ceph 存储集群</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cephfs/">Ceph 文件系统</a></li>
<li class="toctree-l1"><a class="reference internal" href="../rbd/">Ceph 块设备</a></li>
<li class="toctree-l1"><a class="reference internal" href="../radosgw/">Ceph 对象网关</a></li>
<li class="toctree-l1"><a class="reference internal" href="../mgr/">Ceph 管理器守护进程</a></li>
<li class="toctree-l1"><a class="reference internal" href="../mgr/dashboard/">Ceph 仪表盘</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API 文档</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#ceph-restful-api">Ceph RESTful API</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ceph-api">Ceph 存储集群 API</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id1">Ceph 文件系统 API</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id2">Ceph 块设备 API</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ceph-rados-apis">Ceph RADOS 网关 APIs</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id3">Ceph 对象存储 API</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ceph-mon-api">Ceph MON 命令 API</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/">cephadm</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#dashboard">dashboard</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#device">device</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#fs">fs</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#influx">influx</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#k8sevents">k8sevents</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#orch">orch</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#osd">osd</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#progress">progress</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#restful">restful</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#add-bootstrap-peer-hint">add_bootstrap_peer_hint</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#add-bootstrap-peer-hintv">add_bootstrap_peer_hintv</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#auth">auth</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#compact">compact</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#config">config</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#config-key">config-key</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#connection">connection</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#id4">device</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#df">df</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#dump-historic-ops">dump_historic_ops</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#features">features</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#id5">fs</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#fsid">fsid</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#health">health</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#heap">heap</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#injectargs">injectargs</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#log">log</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#mds">mds</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#mgr">mgr</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#mon">mon</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#mon-status">mon_status</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#node-ls">node ls</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#ops">ops</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#id9">osd</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#pg">pg</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#quorum">quorum</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#quorum-status">quorum_status</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#report">report</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#service">service</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#sessions">sessions</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#smart">smart</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#status">status</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#sync-force">sync_force</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#tell">tell</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#time-sync-status">time-sync-status</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#version">version</a></li>
<li class="toctree-l3"><a class="reference internal" href="mon_command_api/#versions">versions</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../architecture/">体系结构</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dev/developer_guide/">开发者指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dev/internals/">Ceph 内幕</a></li>
<li class="toctree-l1"><a class="reference internal" href="../governance/">项目管理</a></li>
<li class="toctree-l1"><a class="reference internal" href="../foundation/">Ceph 基金会</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ceph-volume/">ceph-volume</a></li>
<li class="toctree-l1"><a class="reference internal" href="../releases/general/">Ceph 版本（总目录）</a></li>
<li class="toctree-l1"><a class="reference internal" href="../releases/">Ceph 版本（索引）</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/">Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../glossary/">Ceph 术语</a></li>
<li class="toctree-l1"><a class="reference internal" href="../jaegertracing/">Tracing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../translation_cn/">中文版翻译资源</a></li>
</ul>

            
          
        </div>
        
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../">Ceph</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
<div id="dev-warning" class="admonition note">
  <p class="first admonition-title">Notice</p>
  <p class="last">This document is for a development version of Ceph.</p>
</div>
  <div id="docubetter" align="right" style="padding: 5px; font-weight: bold;">
    <a href="https://pad.ceph.com/p/Report_Documentation_Bugs">Report a Documentation Bug</a>
  </div>

  
  <div class="section" id="api">
<h1>API 文档<a class="headerlink" href="#api" title="Permalink to this headline">¶</a></h1>
<div class="section" id="ceph-restful-api">
<h2>Ceph RESTful API<a class="headerlink" href="#ceph-restful-api" title="Permalink to this headline">¶</a></h2>
<p>见 <a class="reference internal" href="../mgr/ceph_api/#mgr-ceph-api"><span class="std std-ref">Ceph RESTful API</span></a> 。</p>
</div>
<div class="section" id="ceph-api">
<h2>Ceph 存储集群 API<a class="headerlink" href="#ceph-api" title="Permalink to this headline">¶</a></h2>
<p>见 <a class="reference internal" href="../rados/api/#rados-api"><span class="std std-ref">Ceph 存储集群 API</span></a> 。</p>
</div>
<div class="section" id="id1">
<h2>Ceph 文件系统 API<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
<p>见 <a class="reference internal" href="../cephfs/api/#cephfs-api"><span class="std std-ref">CephFS API （编程接口）</span></a> 。</p>
</div>
<div class="section" id="id2">
<h2>Ceph 块设备 API<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
<p>见 <a class="reference internal" href="../rbd/api/librbdpy/#rbd-api-py"><span class="std std-ref">Librbd 的 Python 接口</span></a></p>
</div>
<div class="section" id="ceph-rados-apis">
<h2>Ceph RADOS 网关 APIs<a class="headerlink" href="#ceph-rados-apis" title="Permalink to this headline">¶</a></h2>
<p>见 <a class="reference internal" href="../radosgw/api/#radosgw-api"><span class="std std-ref">librgw (Python)</span></a> 。</p>
</div>
<div class="section" id="id3">
<h2>Ceph 对象存储 API<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p>见 <a class="reference internal" href="../radosgw/s3/#radosgw-s3"><span class="std std-ref">S3-compatible API</span></a> 。</p></li>
<li><p>见 <a class="reference internal" href="../radosgw/swift/#radosgw-swift"><span class="std std-ref">Swift-compatible API</span></a> 。</p></li>
<li><p>见 <a class="reference internal" href="../radosgw/adminops/#radosgw-admin-ops"><span class="std std-ref">Admin Ops API</span></a> 。</p></li>
</ul>
</div>
<div class="section" id="ceph-mon-api">
<h2>Ceph MON 命令 API<a class="headerlink" href="#ceph-mon-api" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p>见 <a class="reference internal" href="mon_command_api/"><span class="doc">Mon 命令 API</span></a> 。</p></li>
</ul>
<div class="toctree-wrapper compound">
</div>
</div>
</div>



           </div>
           
          </div>
          <footer>
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
        <a href="mon_command_api/" class="btn btn-neutral float-right" title="cephadm" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
        <a href="../mgr/cli_api/" class="btn btn-neutral float-left" title="CLI API Commands Module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>
        &#169; Copyright 2016, Ceph authors and contributors. Licensed under Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0).

    </p>
  </div> 

</footer>
        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>